Add some overview documentation about what we're building; update README #351
+186
−74
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
buddhisthead
requested review from
Copilot and
sandtreader
and removed request for
Copilot
SupernaviX
reviewed
Nov 7, 2025
SupernaviX
reviewed
Nov 7, 2025
SupernaviX
reviewed
Nov 7, 2025
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates the project's documentation to reflect its current status and goals. The README has been modernized to indicate the project has moved past the experimental phase, and a new comprehensive overview document describes the five deliverable node types (Archival, Validation, Relay, Block Producing, and Leios nodes) with their use cases and requirements.
- Added a new overview document that details five deliverable node types with their components, use cases, and runtime requirements
- Updated README to reflect project status, add deliverables section, and simplify architecture documentation
- Streamlined the PR template by removing verbose HTML comments
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| docs/overview.md | New comprehensive documentation describing the five node deliverables (Archival, Validation, Relay, Block Producing, and Leios) with detailed component requirements and use cases |
| README.md | Updated to reflect project's production status, added links to overview document, simplified architecture section, and added basic build/run instructions |
| .github/PULL_REQUEST_TEMPLATE.md | Simplified by removing verbose HTML comment blocks while maintaining the same structure and checklist items |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
lowhung
approved these changes
Nov 10, 2025
buddhisthead
force-pushed
the
cet-overview-doc
branch
from
eb19834 to
9b718a0
Compare
… README to be less out of date, but still not complete
buddhisthead
force-pushed
the
cet-overview-doc
branch
from
9b718a0 to
eeb9259
Compare
Collaborator
Author
|
Applied all PR feedback, rebased, squashed. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Update the README to be less out of date, though still not complete.
Update the PR template to be less annoying and busy.
Related Issue(s)
none
How was this tested?
Visually look at the rendered MD, maybe try and follow some links to verity them.
Checklist
Impact / Side effects
none
Reviewer notes / Areas to focus
nope